<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: transport/detail/blob_stream_mq_impl.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_0c017496b493ff066fbbe686970307ba.html">transport</a></li><li class="navelem"><a class="el" href="dir_e82f953eb2d89bcd842ae00e323ae1e5.html">detail</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">blob_stream_mq_impl.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="blob__stream__mq__impl_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Core</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="transport__fwd_8hpp.html">ipc/transport/transport_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__core_2src_2ipc_2transport_2error_8hpp.html">ipc/transport/error.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="shared__name_8hpp.html">ipc/util/shared_name.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;<a class="code" href="detail_2util__fwd_8hpp.html">ipc/util/detail/util_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &lt;flow/error/error.hpp&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#include &lt;flow/log/config.hpp&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#include &lt;boost/interprocess/shared_memory_object.hpp&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#include &lt;boost/move/make_unique.hpp&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1transport.html">ipc::transport</a></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>{</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"></span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment">/**</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * Internal implementation of Blob_stream_mq_base class template; and common utilities used by</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * Blob_stream_mq_sender_impl and Blob_stream_mq_receiver_impl (`static` items only as of this writing).</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> *</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * @tparam Persistent_mq_handle</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> *         See Persistent_mq_handle concept doc header.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> */</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Persistent_mq_handle&gt;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html">   42</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html">Blob_stream_mq_base_impl</a></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>{</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"></span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment">  /// Short-hand for template arg for underlying MQ handle type.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a8fac0ed5fff23aa42e0a601db6fee42d">   48</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Mq</a> = <a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"></span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment">   * Persistent_mq_handle holder that takes a deleter lambda on construction, intended here to perform additional deinit</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment">   * steps in addition to closing the #Mq by deleting it.  Used by ensure_unique_peer() machinery.</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment">   */</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#aab7c4c91d42c746c93e61eb367572eb1">   54</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#aab7c4c91d42c746c93e61eb367572eb1">Auto_closing_mq</a> = boost::movelib::unique_ptr&lt;<a class="code hl_typedef" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a8fac0ed5fff23aa42e0a601db6fee42d">Mq</a>, <a class="code hl_typedef" href="namespaceipc.html#aa455c7f045059736578ca275fc1a851f">Function</a>&lt;void (<a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Mq</a>*)&gt;&gt;;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"></span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment">   * See Blob_stream_mq_base counterpart.</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment">   *</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment">   *        See Blob_stream_mq_base counterpart.</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment">   * @param name</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment">   *        See Blob_stream_mq_base counterpart.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment">   *        See Blob_stream_mq_base counterpart.</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment">   */</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a8877f75af055ab927a4b4c993f0873a2">remove_persistent</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; name, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"></span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">   * See Blob_stream_mq_base counterpart.</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">   *</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">   * @tparam Handle_name_func</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">   *         See Blob_stream_mq_base counterpart.</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">   * @param handle_name_func</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">   *        See Blob_stream_mq_base counterpart.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">   */</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handle_name_func&gt;</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a88105803396fe1f60faab3b0bad97785">for_each_persistent</a>(<span class="keyword">const</span> Handle_name_func&amp; handle_name_func);</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"></span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">   * Internal helper for Blob_stream_mq_sender and Blob_stream_mq_receiver that operates both the start and end</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">   * of the anti-dupe-endpoint machinery used by those 2 classes to prevent more than 1 `_sender` and more than 1</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">   * `_receiver` for a given underlying MQ.</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment">   *</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">   * The input is a handle to the MQ, as created by user as of this writing, either on the sender or receiver</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">   * end (`snd_else_rcv`).  The output is one of:</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">   *   - a null return, indicating that either there&#39;s already a sender (or receiver) already registered (typically),</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">   *     or some other (unlikely) system error.  `*err_code` will indicate what happened; or</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">   *   - a non-null returned `unique_ptr` that has moved `mq` into itself/taken over ownership of it, with certain</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment">   *     machinery such that when that `unique_ptr` (or moved version thereof) is `.reset()` or destroyed,</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment">   *     the proper deinit will run, making it possible to create another MQ at the same Shared_name.</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">   *</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">   * `mq` is untouched if null is returned.</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment">   *</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment">   *        Logger to use subsequently. Errors are logged as WARNING; otherwise nothing of INFO or higher verbosity</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment">   *        is logged.</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment">   * @param mq</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">   * @param snd_else_rcv</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment">   *        `true` if this is the sender side; else the receiver side.</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment">   *        Must not be null, or behavior undefined; will be set to success if non-null returned or reason for failure</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment">   *        otherwise.</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment">   * @return null or pointer to new Persistent_mq_handle moved-from `mq`, and with deinit deleter.</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment">   */</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>  <span class="keyword">static</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#aab7c4c91d42c746c93e61eb367572eb1">Auto_closing_mq</a> <a class="code hl_function" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a4776b5f569ccac03eccb3fc2f360fcc9">ensure_unique_peer</a>(flow::log::Logger* logger_ptr, <a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Mq</a>&amp;&amp; mq, <span class="keywordtype">bool</span> snd_else_rcv,</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>                                            <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code);</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"></span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment">   * If Blob_stream_mq_sender_impl sends an empty message, in NORMAL state Blob_stream_mq_receiver enters CONTROL</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">   * state and expects one of these values in the next message, to react as documented per `enum` value</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment">   * (upon re-entering NORMAL state).</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment">   *</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment">   * ### Rationale: Why is the underlying type signed? ###</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment">   * There is a special type of CONTROL command used only at the beginning of the conversation: protocol negotiation;</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">   * each side sends to the other the highest protocol version it can speak.  In that case instead of using one of</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">   * the `enum` encodings it sends the encoding of the inverse of the version number which is always positive</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment">   * (so -1 means version 1, -2 means 2, etc.).  Using a signed type makes working with that eventuality a little</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">   * easier and more expressive.  (No, we don&#39;t really expect the `enum` variants to anywhere close to all these</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">   * bits anyway.)</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment">   *</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment">   * ### Rationale: Why 64 bits? ###</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">   * No huge reason.  It felt prudent to leave a bit of reserved space, maybe for forward compatibility.</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment">   * CONTROL messages are rare, so it should not affect perf.</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment">   */</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a2e46672d40fbf38cf6054edfad69e705">  131</a></span>  <span class="keyword">enum class</span> <a class="code hl_enumeration" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a2e46672d40fbf38cf6054edfad69e705">Control_cmd</a> : int64_t</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span>  {<span class="comment"></span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment">    /// Indicates sender user invoked Blob_sender::end_sending() (graceful close).  Emit/queue graceful-close to user.</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"></span>    S_END_SENDING,</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"></span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment">     * Indicates sender user invoked auto_ping() earlier, and this is an incoming periodic ping.  If</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment">     * receiver user invoked idle_timer_run() earlier, reset countdown to death due to lacking in-pings.</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment">     */</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>    S_PING,</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"></span> </div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment">    /// Sentinel: not a valid value.  May be used to, e.g., ensure validity of incoming value of allegedly this type.</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment"></span>    <a class="code hl_enumvalue" href="namespaceipc.html#a4ccdeed058222c635745a4dc830e99f7a6fba12db09e5bebfaa04f6372c41c2cf">S_END_SENTINEL</a></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>  }; <span class="comment">// enum class Control_cmd</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span> </div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"></span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment">   * Name of sentinel SHM pool created by ensure_unique_peer() and potentially cleaned up by remove_persistent().</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment">   *</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment">   * @param mq_name</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment">   *        `mq.absolute_name()`.  See ensure_unique_peer().</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment">   * @param snd_else_rcv</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment">   *        See ensure_unique_peer().</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment">   * @return Absolute name.</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment">   */</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span>  <span class="keyword">static</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_function" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#ad64ef04f561dcb09e473be433df81074">mq_sentinel_name</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; mq_name, <span class="keywordtype">bool</span> snd_else_rcv);</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span>}; <span class="comment">// class Blob_stream_mq_base_impl</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span> </div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span> </div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Persistent_mq_handle&gt;</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a8877f75af055ab927a4b4c993f0873a2">  164</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a8877f75af055ab927a4b4c993f0873a2">Blob_stream_mq_base_impl&lt;Persistent_mq_handle&gt;::remove_persistent</a>(flow::log::Logger* logger_ptr, <span class="comment">// Static.</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>                                                                       <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; name, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code)</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>{</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span>  <span class="keyword">using </span><a class="code hl_function" href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">util::remove_persistent_shm_pool</a>;</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span> </div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span>  <span class="keywordflow">if</span> (flow::error::exec_void_and_throw_on_error</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span>        ([&amp;](<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* actual_err_code)</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span>           { remove_persistent(logger_ptr, name, actual_err_code); },</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span>         err_code, <span class="stringliteral">&quot;Blob_stream_mq_base_impl::remove_persistent()&quot;</span>))</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span>  {</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span>  }</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span>  assert(err_code);</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span> </div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span>  <span class="comment">// This part is the no-brainer:</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span>  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> mq_err_code;</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span>  Mq::remove_persistent(logger_ptr, name, &amp;mq_err_code);</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span> </div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span>  <span class="comment">/* This part is what is needed on top of the above, because Blob_stream_mq_*er also creates these little pools</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment">   * to keep track of uniqueness (that there&#39;s only one sender and receiver per MQ). */</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span>  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> sentinel_err_code1;</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span>  <a class="code hl_function" href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">remove_persistent_shm_pool</a>(logger_ptr, mq_sentinel_name(name, <span class="keyword">true</span>), &amp;sentinel_err_code1);</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span>  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> sentinel_err_code2;</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span>  <a class="code hl_function" href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">remove_persistent_shm_pool</a>(logger_ptr, mq_sentinel_name(name, <span class="keyword">false</span>), &amp;sentinel_err_code2);</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span> </div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span>  <span class="comment">// Report an error &lt;=&gt; any one of three failed; but the key MQ&#39;s error (if it occurred) &quot;wins.&quot;</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span>  *err_code = mq_err_code ? mq_err_code</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span>                          : (sentinel_err_code1 ? sentinel_err_code1 : sentinel_err_code2);</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span>} <span class="comment">// Blob_stream_mq_base_impl::remove_persistent()</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span> </div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Persistent_mq_handle&gt;</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handle_name_func&gt;</div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="keywordtype">void</span> <span class="comment">// Static.</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a88105803396fe1f60faab3b0bad97785">  198</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a88105803396fe1f60faab3b0bad97785">Blob_stream_mq_base_impl&lt;Persistent_mq_handle&gt;::for_each_persistent</a>(<span class="keyword">const</span> Handle_name_func&amp; handle_name_func)</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span>{</div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span>  <span class="comment">// Do exactly what we promised in contract.</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span>  Mq::for_each_persistent(handle_name_func);</div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span> </div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span>  <span class="comment">/* Discussion: Is what we promised actually the right thing to promise though?  Answer: Yes and no.  Or:</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment">   * Yes, within reason.  ensure_unique_peer(), in the deleter it generated/returns in the Auto_closing_mq,</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment">   * deletes the MQ and both sentinels.  (The other-direction ensure_unique_peer() then loses the race and has</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment">   * nothing to delete in its Auto_closing_mq; and that&#39;s fine.)  The deleter first removes the sentinels, then</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment">   * the MQ; so even if the abort occurred *during* the deleter, listing the still-existing MQs now should</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment">   * yield all MQs for which there are still resources to delete (at least the MQ entry; and possibly 0, 1, or 2</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment">   * sentinels, depending on when the abort occurred (probably 2, in most cases, unless unlucky).</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment">   *</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment">   * We could also list all SHM pools matching the naming convention we use in mq_sentinel_name(), deducing</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment">   * the MQ name from any sentinel name found and adding that to the list we emit.  Frankly I (ygoldfel) simply</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment">   * don&#39;t want to.  This is a best-effort cleanup for abort situation only; and we do remove the MQ last</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment">   * in the deleter, so everything should work out fine this way, and the code is simple. */</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span>} <span class="comment">// Blob_stream_mq_base_impl::for_each_persistent()</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span> </div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Persistent_mq_handle&gt;</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#aab7c4c91d42c746c93e61eb367572eb1">Blob_stream_mq_base_impl&lt;Persistent_mq_handle&gt;::Auto_closing_mq</a></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a4776b5f569ccac03eccb3fc2f360fcc9">  219</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a4776b5f569ccac03eccb3fc2f360fcc9">Blob_stream_mq_base_impl&lt;Persistent_mq_handle&gt;::ensure_unique_peer</a>(flow::log::Logger* logger_ptr, <span class="comment">// Static.</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span>                                                                     <a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Mq</a>&amp;&amp; mq, <span class="keywordtype">bool</span> snd_else_rcv,</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span>                                                                     <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code)</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span>{</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span>  <span class="keyword">using </span><a class="code hl_function" href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">util::remove_persistent_shm_pool</a>;</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span>  <span class="keyword">using </span>flow::error::Runtime_error;</div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span>  <span class="keyword">using </span>flow::log::Sev;</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span>  <span class="keyword">using </span>boost::system::system_category;</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span>  <span class="keyword">using </span>boost::movelib::make_unique;</div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span>  <span class="keyword">using </span>bipc::shared_memory_object;</div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span> </div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span>  FLOW_LOG_SET_CONTEXT(logger_ptr, Log_component::S_TRANSPORT); <span class="comment">// @todo Maybe just make this method non-static.</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span>  assert(err_code);</div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span> </div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span>  <span class="comment">/* Read Blob_stream_mq_sender class doc header (particularly regarding lifetimes of things); then return here.</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment">   * Summarizing:</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment">   *</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment">   * We&#39;ve promised to enforce certain semantics, namely that a given MQ can be accessed, ever, by</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment">   * at most 1 Blob_stream_mq_sender (and 1 _receiver) -- across all processes, not just this one.</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment">   * So we do that here by maintaining a separate SHM-stored record indicating a _sender (or _receiver) exists already.</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment">   *</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment">   * Also we have to make it so that if _sender dtor (or _receiver dtor,</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment">   * whichever happens first) runs, within a short amount of time after that, they can again open a *new*</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment">   * channel at the same Shared_name.  (In a sense we&#39;re trying to make our _sender/_receiver pair similar to</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment">   * a peer-pair Unix domain socket connection: once you close it: only two sides to it (though ours is 1-directional);</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment">   * and destroying either side hoses the connection.)  To do that, we put a custom deleter on the MQ unique_ptr:</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment">   * once it goes away (whether in dtor, or earlier due to fatal error when sending/whatever), we have to &quot;undo&quot;</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment">   * whatever mechanism is guarding against multiple `_sender`s (or `_receiver`s) at that Shared_name. */</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span> </div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span>  <span class="comment">/* First atomically attempt to create a tiny dummy SHM pool whose existence indicates a Blob_stream_mq_....er</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span><span class="comment">   * to that absolute_name() exists.  Its name: */</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span> </div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span>  <span class="keyword">const</span> <span class="keyword">auto</span> sentinel_name = mq_sentinel_name(mq.absolute_name(), snd_else_rcv);</div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span> </div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span>  FLOW_LOG_TRACE(<span class="stringliteral">&quot;MQ handle [&quot;</span> &lt;&lt; mq &lt;&lt; <span class="stringliteral">&quot;]: Atomic-creating sentinel SHM-pool [&quot;</span> &lt;&lt; sentinel_name &lt;&lt; <span class="stringliteral">&quot;] &quot;</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span>                 <span class="stringliteral">&quot;to ensure no more than 1 [&quot;</span> &lt;&lt; (snd_else_rcv ? <span class="stringliteral">&quot;snd&quot;</span> : <span class="stringliteral">&quot;rcv&quot;</span>) &lt;&lt; <span class="stringliteral">&quot;] side of pipe exists.&quot;</span>);</div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span>  <span class="keywordflow">try</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span>  {</div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span>    <span class="comment">/* Permissions note: leave at default (*nix: 644, meaning read/write by this user, read only for everyone else).</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">     * However this controls writing to the pool itself -- but no one will be writing to the pool; it is only a</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment">     * sentinel by its existence.  Hence maybe we could restrict it even more, but probably it is not important.</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">     * @todo For good measure look into restricting it more; maybe even 000. */</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span>    [[maybe_unused]] <span class="keyword">auto</span> shm_pool_sentinel</div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span>      = make_unique&lt;shared_memory_object&gt;(<a class="code hl_variable" href="namespaceipc_1_1util.html#ad1ca1cab79a35e1eb1c47037a0973cd8">util::CREATE_ONLY</a>, sentinel_name.native_str(), bipc::read_only);</div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span>    <span class="comment">// On success it is immediately destroyed... but the name, and tiny SHM pool, lives on until deleter below execs.</span></div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span>  }</div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span>  <span class="keywordflow">catch</span> (<span class="keyword">const</span> bipc::interprocess_exception&amp; exc)</div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span>  {</div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span>    <span class="keyword">const</span> <span class="keyword">auto</span> native_code_raw = exc.get_native_error();</div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span>    <span class="keyword">const</span> <span class="keyword">auto</span> bipc_err_code_enum = exc.get_error_code();</div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span>    <span class="keyword">const</span> <span class="keywordtype">bool</span> is_dupe_error = bipc_err_code_enum == bipc::already_exists_error;</div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span>    FLOW_LOG_WARNING(<span class="stringliteral">&quot;MQ handle [&quot;</span> &lt;&lt; mq &lt;&lt; <span class="stringliteral">&quot;]: While creating [&quot;</span> &lt;&lt; (snd_else_rcv ? <span class="stringliteral">&quot;send&quot;</span> : <span class="stringliteral">&quot;receiv&quot;</span>) &lt;&lt; <span class="stringliteral">&quot;er] &quot;</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span>                     <span class="stringliteral">&quot;was checking none already exists in any process, as this is a one-directional pipe; &quot;</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span>                     <span class="stringliteral">&quot;tried to create SHM sentinel pool [&quot;</span> &lt;&lt; sentinel_name &lt;&lt; <span class="stringliteral">&quot;]; &quot;</span></div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span>                     <span class="stringliteral">&quot;bipc threw interprocess_exception; will emit some hopefully suitable Flow-IPC Error_code; &quot;</span></div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span>                     <span class="stringliteral">&quot;probably it&#39;s already-exists error meaning dupe-sender; &quot;</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span>                     <span class="stringliteral">&quot;but here are all the details of the original exception: native code int &quot;</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span>                     <span class="stringliteral">&quot;[&quot;</span> &lt;&lt; native_code_raw &lt;&lt; <span class="stringliteral">&quot;]; bipc error_code_t enum-&gt;int &quot;</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span>                     <span class="stringliteral">&quot;[&quot;</span> &lt;&lt; <span class="keywordtype">int</span>(bipc_err_code_enum) &lt;&lt; <span class="stringliteral">&quot;]; latter==already-exists = [&quot;</span> &lt;&lt; is_dupe_error &lt;&lt; <span class="stringliteral">&quot;]; &quot;</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span>                     <span class="stringliteral">&quot;message = [&quot;</span> &lt;&lt; exc.what() &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span>    *err_code = is_dupe_error ? <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>(snd_else_rcv</div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span>                                             ? <a class="code hl_enumvalue" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a5026917d99ad25df8bc708cc6628f28c">error::Code::S_BLOB_STREAM_MQ_SENDER_EXISTS</a></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span>                                             : <a class="code hl_enumvalue" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297af6ee4717280d29cc272ef2a356ad3982">error::Code::S_BLOB_STREAM_MQ_RECEIVER_EXISTS</a>)</div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span>                              : <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>(errno, system_category());</div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span>    <span class="keywordflow">return</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#aab7c4c91d42c746c93e61eb367572eb1">Auto_closing_mq</a>();</div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span>  } <span class="comment">// catch (bipc::interprocess_exception)</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span>  <span class="comment">// Got here: OK, no dupe, no other problem.</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span>  err_code-&gt;clear();</div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span> </div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span>  <span class="comment">/* Now take over their MQ handle.  As noted above set up the auto-closing extra behavior to keep above scheme working,</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment">   * if they want to reuse the name to make another MQ later (although informally we don&#39;t recommend it -- much</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment">   * like, conceptually, binding a TCP socket to the same port soon after closing another can bring problems). */</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span>  <span class="keywordflow">return</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#aab7c4c91d42c746c93e61eb367572eb1">Auto_closing_mq</a>(<span class="keyword">new</span> <a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Mq</a>(std::move(mq)), <span class="comment">// Now we own the MQ handle.</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span>                         [get_logger, get_log_component, snd_else_rcv, sentinel_name](<a class="code hl_class" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Mq</a>* mq_ptr)</div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span>  {</div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span>    <span class="keyword">const</span> <span class="keyword">auto</span> other_sentinel_name = mq_sentinel_name(mq_ptr-&gt;<a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a5ef74ca74a9d985710af974fd6518940">absolute_name</a>(), !snd_else_rcv);</div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span> </div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span>    FLOW_LOG_INFO(<span class="stringliteral">&quot;MQ handle [&quot;</span> &lt;&lt; *mq_ptr &lt;&lt; <span class="stringliteral">&quot;]: MQ handle ([&quot;</span> &lt;&lt; (snd_else_rcv ? <span class="stringliteral">&quot;send&quot;</span> : <span class="stringliteral">&quot;receiv&quot;</span>) &lt;&lt; <span class="stringliteral">&quot;er] &quot;</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span>                  <span class="stringliteral">&quot;side of pipe) about to close.  Hence by contract closing pipe itself too.  &quot;</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span>                  <span class="stringliteral">&quot;To prevent any attempt to reattach to underlying MQ &quot;</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span>                  <span class="stringliteral">&quot;we make MQ anonymous by removing persistent-MQ-name [&quot;</span> &lt;&lt; mq_ptr-&gt;<a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a5ef74ca74a9d985710af974fd6518940">absolute_name</a>() &lt;&lt; <span class="stringliteral">&quot;].  &quot;</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span>                  <span class="stringliteral">&quot;Then removing sentinel SHM-pool [&quot;</span> &lt;&lt; sentinel_name &lt;&lt; <span class="stringliteral">&quot;] to enable reuse of name for new MQ; &quot;</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span>                  <span class="stringliteral">&quot;as well as the other-direction sentinel SHM-pool [&quot;</span> &lt;&lt; other_sentinel_name &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span> </div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span>    <span class="comment">/* (If sender does it first, receiver will fail here; and vice versa.  Just eat all logging (null logger);</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment">     * and ignore any errors below. Nothing we can do anyway.) */</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span>    <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> sink;</div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span> </div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span>    <span class="comment">// Blob_stream_mq_*er&lt;Mq&gt;(Mq(mq.absolute_name())) would fail until we do:</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span> </div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span>    <a class="code hl_function" href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">remove_persistent_shm_pool</a>(<span class="keyword">nullptr</span>, sentinel_name, &amp;sink);</div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span>    <a class="code hl_function" href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">remove_persistent_shm_pool</a>(<span class="keyword">nullptr</span>, other_sentinel_name, &amp;sink);</div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span> </div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span>    <span class="comment">// Mq(Open_only, mq.absolute_name()) would now succeed.  Mq(Create_only, mq.absolute_name()) would now fail.</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span>    Mq::remove_persistent(<span class="keyword">nullptr</span>, mq_ptr-&gt;<a class="code hl_function" href="classipc_1_1transport_1_1Persistent__mq__handle.html#a5ef74ca74a9d985710af974fd6518940">absolute_name</a>(), &amp;sink);</div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span>    <span class="comment">// Mq(Open_only, mq.absolute_name()) would now fail.  Mq(Create_only, mq.absolute_name()) would now succeed.</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span> </div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span>    <span class="comment">/* Discussion:</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="comment">     *   - The order (sentinels versus MQ itself) is ~reversed compared to the creation, where MQ is made first.</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment">     *     In general that&#39;s a good idea (all else being equal); but specifically it could help avoid a corner</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">     *     case involving post-abort cleanup using for_each_persistent() and remove_persistent(): If an abort</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment">     *     occurs during the code you&#39;re reading now, the thing on which for_each_persistent() is keyed</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment">     *     (listing of the MQs) is the last thing removed.  Otherwise the sentinel(s) could get leaked, if abort</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment">     *     occurs after MQ removed but before the sentinel(s) are; for_each_persistent() won&#39;t detect it/them.</span></div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment">     *</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span><span class="comment">     * - Is it weird we *created* sentinel_name pool but are deleting both it and the one that would&#39;ve been</span></div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment">     *   created by the other-direction peer&#39;s invocation of the present function?  It does seem weird, but it&#39;s</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment">     *   actually good and proactive; and safe.</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment">     *   - Is it safe?  Answer: If the other sentinel exists still, then the other-direction peer dtor has not yet run.</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span><span class="comment">     *     The sentinel is only useful if they try to create (open-only) another other-direction peer for the same name.</span></div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment">     *     That will fail in any case though: we just removed the MQ!  If they try to create such a peer in</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment">     *     create mode, then they are breaking the contract wherein they must not reuse a name until both dtors</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">     *     have executed (and even then, it is *recommended* a name is never reused, or not anytime soon at least).</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment">     *     So yes, it is safe, in that the only reason the other-direction sentinel would even be checked does not</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment">     *     validly exist at this stage.</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment">     *   - Is it beneficial?  Answer: Yes, because it means in practice all 3 persistent items will be deleted at</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment">     *     essentially the same time.  This helps avoid an on-abort leak mentioned in for_each_persistent(). */</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span> </div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span>    <span class="comment">// Lastly... don&#39;t forget:</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span> </div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span>    <span class="keyword">delete</span> mq_ptr;</div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span>  }); <span class="comment">// return make_unique&lt;Mq&gt;()</span></div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span>} <span class="comment">// Blob_stream_mq_base_impl::ensure_unique_peer()</span></div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span> </div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Persistent_mq_handle&gt;</div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#ad64ef04f561dcb09e473be433df81074">  344</a></span><a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_function" href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#ad64ef04f561dcb09e473be433df81074">Blob_stream_mq_base_impl&lt;Persistent_mq_handle&gt;::mq_sentinel_name</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; mq_name,</div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span>                                                                             <span class="keywordtype">bool</span> snd_else_rcv)</div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span>{</div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span>  <span class="keyword">using </span><a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">util::String_view</a>;</div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span> </div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span>  <span class="keyword">auto</span> sentinel_name</div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span>    = <a class="code hl_function" href="namespaceipc_1_1util.html#a71fa0c2bd2c45109a9fbab4b048c666d">build_conventional_non_session_based_shared_name</a>(<a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a4c294e23753eb706b4c297d99d24cd48">Shared_name::S_RESOURCE_TYPE_ID_SHM</a>); <span class="comment">// It&#39;s a (silly) SHM pool.</span></div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span>  <span class="comment">// That was the standard stuff.  Now the us-specific stuff:</span></div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span>  sentinel_name /= Mq::S_RESOURCE_TYPE_ID; <span class="comment">// Differentiate between different MQ types.</span></div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span>  sentinel_name /= <span class="stringliteral">&quot;sentinel&quot;</span>;</div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span>  sentinel_name += <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">String_view</a>(snd_else_rcv ? <span class="stringliteral">&quot;Snd&quot;</span> : <span class="stringliteral">&quot;Rcv&quot;</span>);</div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span>  assert(mq_name.<a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#ab1934f80515fdbc3e2a59ccda32fff9a">absolute</a>());</div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span>  sentinel_name += mq_name; <span class="comment">// The MQ name -- ALL of it -- is completely in here (starting with separator).</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span> </div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span>  <span class="keywordflow">return</span> sentinel_name;</div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span>}</div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span> </div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span>} <span class="comment">// namespace ipc::transport</span></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Blob__stream__mq__base__impl_html"><div class="ttname"><a href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html">ipc::transport::Blob_stream_mq_base_impl</a></div><div class="ttdoc">Internal implementation of Blob_stream_mq_base class template; and common utilities used by Blob_stre...</div><div class="ttdef"><b>Definition:</b> <a href="blob__stream__mq__impl_8hpp_source.html#l00042">blob_stream_mq_impl.hpp:43</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Blob__stream__mq__base__impl_html_a2e46672d40fbf38cf6054edfad69e705"><div class="ttname"><a href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a2e46672d40fbf38cf6054edfad69e705">ipc::transport::Blob_stream_mq_base_impl::Control_cmd</a></div><div class="ttdeci">Control_cmd</div><div class="ttdoc">If Blob_stream_mq_sender_impl sends an empty message, in NORMAL state Blob_stream_mq_receiver enters ...</div><div class="ttdef"><b>Definition:</b> <a href="blob__stream__mq__impl_8hpp_source.html#l00131">blob_stream_mq_impl.hpp:132</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Blob__stream__mq__base__impl_html_a4776b5f569ccac03eccb3fc2f360fcc9"><div class="ttname"><a href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a4776b5f569ccac03eccb3fc2f360fcc9">ipc::transport::Blob_stream_mq_base_impl::ensure_unique_peer</a></div><div class="ttdeci">static Auto_closing_mq ensure_unique_peer(flow::log::Logger *logger_ptr, Mq &amp;&amp;mq, bool snd_else_rcv, Error_code *err_code)</div><div class="ttdoc">Internal helper for Blob_stream_mq_sender and Blob_stream_mq_receiver that operates both the start an...</div><div class="ttdef"><b>Definition:</b> <a href="blob__stream__mq__impl_8hpp_source.html#l00219">blob_stream_mq_impl.hpp:219</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Blob__stream__mq__base__impl_html_a88105803396fe1f60faab3b0bad97785"><div class="ttname"><a href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a88105803396fe1f60faab3b0bad97785">ipc::transport::Blob_stream_mq_base_impl::for_each_persistent</a></div><div class="ttdeci">static void for_each_persistent(const Handle_name_func &amp;handle_name_func)</div><div class="ttdoc">See Blob_stream_mq_base counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="blob__stream__mq__impl_8hpp_source.html#l00198">blob_stream_mq_impl.hpp:198</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Blob__stream__mq__base__impl_html_a8877f75af055ab927a4b4c993f0873a2"><div class="ttname"><a href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a8877f75af055ab927a4b4c993f0873a2">ipc::transport::Blob_stream_mq_base_impl::remove_persistent</a></div><div class="ttdeci">static void remove_persistent(flow::log::Logger *logger_ptr, const Shared_name &amp;name, Error_code *err_code)</div><div class="ttdoc">See Blob_stream_mq_base counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="blob__stream__mq__impl_8hpp_source.html#l00164">blob_stream_mq_impl.hpp:164</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Blob__stream__mq__base__impl_html_a8fac0ed5fff23aa42e0a601db6fee42d"><div class="ttname"><a href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#a8fac0ed5fff23aa42e0a601db6fee42d">ipc::transport::Blob_stream_mq_base_impl::Mq</a></div><div class="ttdeci">Persistent_mq_handle Mq</div><div class="ttdoc">Short-hand for template arg for underlying MQ handle type.</div><div class="ttdef"><b>Definition:</b> <a href="blob__stream__mq__impl_8hpp_source.html#l00048">blob_stream_mq_impl.hpp:48</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Blob__stream__mq__base__impl_html_aab7c4c91d42c746c93e61eb367572eb1"><div class="ttname"><a href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#aab7c4c91d42c746c93e61eb367572eb1">ipc::transport::Blob_stream_mq_base_impl::Auto_closing_mq</a></div><div class="ttdeci">boost::movelib::unique_ptr&lt; Mq, Function&lt; void(Mq *)&gt; &gt; Auto_closing_mq</div><div class="ttdoc">Persistent_mq_handle holder that takes a deleter lambda on construction, intended here to perform add...</div><div class="ttdef"><b>Definition:</b> <a href="blob__stream__mq__impl_8hpp_source.html#l00054">blob_stream_mq_impl.hpp:54</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Blob__stream__mq__base__impl_html_ad64ef04f561dcb09e473be433df81074"><div class="ttname"><a href="classipc_1_1transport_1_1Blob__stream__mq__base__impl.html#ad64ef04f561dcb09e473be433df81074">ipc::transport::Blob_stream_mq_base_impl::mq_sentinel_name</a></div><div class="ttdeci">static Shared_name mq_sentinel_name(const Shared_name &amp;mq_name, bool snd_else_rcv)</div><div class="ttdoc">Name of sentinel SHM pool created by ensure_unique_peer() and potentially cleaned up by remove_persis...</div><div class="ttdef"><b>Definition:</b> <a href="blob__stream__mq__impl_8hpp_source.html#l00344">blob_stream_mq_impl.hpp:344</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html">ipc::transport::Persistent_mq_handle</a></div><div class="ttdoc">A documentation-only concept defining the behavior of an object representing a light-weight handle to...</div><div class="ttdef"><b>Definition:</b> <a href="persistent__mq__handle_8hpp_source.html#l00194">persistent_mq_handle.hpp:195</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Persistent__mq__handle_html_a5ef74ca74a9d985710af974fd6518940"><div class="ttname"><a href="classipc_1_1transport_1_1Persistent__mq__handle.html#a5ef74ca74a9d985710af974fd6518940">ipc::transport::Persistent_mq_handle::absolute_name</a></div><div class="ttdeci">const Shared_name &amp; absolute_name() const</div><div class="ttdoc">Returns name equal to absolute_name passed to ctor.</div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html">ipc::util::Shared_name</a></div><div class="ttdoc">String-wrapping abstraction representing a name uniquely distinguishing a kernel-persistent entity fr...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00241">shared_name.hpp:242</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a4c294e23753eb706b4c297d99d24cd48"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a4c294e23753eb706b4c297d99d24cd48">ipc::util::Shared_name::S_RESOURCE_TYPE_ID_SHM</a></div><div class="ttdeci">static const Shared_name S_RESOURCE_TYPE_ID_SHM</div><div class="ttdoc">Relative-folder fragment (no separators) identifying the resource type for: SHM pools.</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00312">shared_name.hpp:312</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_ab1934f80515fdbc3e2a59ccda32fff9a"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#ab1934f80515fdbc3e2a59ccda32fff9a">ipc::util::Shared_name::absolute</a></div><div class="ttdeci">bool absolute() const</div><div class="ttdoc">Returns true if and only if the first character is S_SEPARATOR.</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00165">shared_name.cpp:165</a></div></div>
<div class="ttc" id="adetail_2util__fwd_8hpp_html"><div class="ttname"><a href="detail_2util__fwd_8hpp.html">util_fwd.hpp</a></div></div>
<div class="ttc" id="aipc__core_2src_2ipc_2transport_2error_8hpp_html"><div class="ttname"><a href="ipc__core_2src_2ipc_2transport_2error_8hpp.html">error.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1error_html_adfef15ef4e76cc55d652fbd9c2797297a5026917d99ad25df8bc708cc6628f28c"><div class="ttname"><a href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297a5026917d99ad25df8bc708cc6628f28c">ipc::transport::error::Code::S_BLOB_STREAM_MQ_SENDER_EXISTS</a></div><div class="ttdeci">@ S_BLOB_STREAM_MQ_SENDER_EXISTS</div><div class="ttdoc">Message-queue blob stream outgoing-direction peer could not be created, because one already exists at...</div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1error_html_adfef15ef4e76cc55d652fbd9c2797297af6ee4717280d29cc272ef2a356ad3982"><div class="ttname"><a href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297af6ee4717280d29cc272ef2a356ad3982">ipc::transport::error::Code::S_BLOB_STREAM_MQ_RECEIVER_EXISTS</a></div><div class="ttdeci">@ S_BLOB_STREAM_MQ_RECEIVER_EXISTS</div><div class="ttdoc">Message-queue blob stream incoming-direction peer could not be created, because one already exists at...</div></div>
<div class="ttc" id="anamespaceipc_1_1transport_html"><div class="ttname"><a href="namespaceipc_1_1transport.html">ipc::transport</a></div><div class="ttdoc">Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...</div><div class="ttdef"><b>Definition:</b> <a href="asio__local__stream__socket_8cpp_source.html#l00031">asio_local_stream_socket.cpp:32</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a1cdc0a8d761170faa844c49d37c522ff"><div class="ttname"><a href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">ipc::util::remove_persistent_shm_pool</a></div><div class="ttdeci">void remove_persistent_shm_pool(flow::log::Logger *logger_ptr, const Shared_name &amp;pool_name, Error_code *err_code)</div><div class="ttdoc">Equivalent to shm::classic::Pool_arena::remove_persistent().</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00119">util.cpp:119</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a71fa0c2bd2c45109a9fbab4b048c666d"><div class="ttname"><a href="namespaceipc_1_1util.html#a71fa0c2bd2c45109a9fbab4b048c666d">ipc::util::build_conventional_non_session_based_shared_name</a></div><div class="ttdeci">Shared_name build_conventional_non_session_based_shared_name(const Shared_name &amp;resource_type)</div><div class="ttdoc">Builds an absolute name according to the path convention explained in Shared_name class doc header; t...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00337">shared_name.cpp:337</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ad1ca1cab79a35e1eb1c47037a0973cd8"><div class="ttname"><a href="namespaceipc_1_1util.html#ad1ca1cab79a35e1eb1c47037a0973cd8">ipc::util::CREATE_ONLY</a></div><div class="ttdeci">const Create_only CREATE_ONLY</div><div class="ttdoc">Tag value indicating an atomic create-unless-exists-else-fail operation.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2util_8cpp_source.html#l00032">util.cpp:32</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae6ac47812a90d1287c61e0b7de7bc4f5"><div class="ttname"><a href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">ipc::util::String_view</a></div><div class="ttdeci">flow::util::String_view String_view</div><div class="ttdoc">Short-hand for Flow's String_view.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00115">util_fwd.hpp:115</a></div></div>
<div class="ttc" id="anamespaceipc_html_a4ccdeed058222c635745a4dc830e99f7a6fba12db09e5bebfaa04f6372c41c2cf"><div class="ttname"><a href="namespaceipc.html#a4ccdeed058222c635745a4dc830e99f7a6fba12db09e5bebfaa04f6372c41c2cf">ipc::Log_component::S_END_SENTINEL</a></div><div class="ttdeci">@ S_END_SENTINEL</div><div class="ttdoc">CAUTION – see ipc::Log_component doc header for directions to find actual members of this enum class.</div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa455c7f045059736578ca275fc1a851f"><div class="ttname"><a href="namespaceipc.html#aa455c7f045059736578ca275fc1a851f">ipc::Function</a></div><div class="ttdeci">flow::Function&lt; Signature &gt; Function</div><div class="ttdoc">Short-hand for polymorphic functor holder which is very common. This is essentially std::function.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00302">common.hpp:302</a></div></div>
<div class="ttc" id="ashared__name_8hpp_html"><div class="ttname"><a href="shared__name_8hpp.html">shared_name.hpp</a></div></div>
<div class="ttc" id="atransport__fwd_8hpp_html"><div class="ttname"><a href="transport__fwd_8hpp.html">transport_fwd.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
